Azure Maps Search Service (preview:1.0)

2025/08/14 • 15 deleted methods

Search_GetSearchPolygon (removed)
Description :  **Get Polygon** **Applies to**: S1 pricing tier. The Get Polygon service allows you to request the geometry data such as a city or country outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the dataSources object under "geometry" and "id" in either a Search Address or Search Fuzzy call. Please note that any geometry ID retrieved from an Online Search endpoint has a limited lifetime. The client should not store geometry IDs in persistent storage for later referral, as the stability of these identifiers is not guaranteed for a long period of time. It is expected that a request to the Polygon method is made within a few minutes of the request to the Online Search method that provided the ID. The service allows for batch requests up to 20 identifiers.
Reference :  Link ¶

⚼ Request

GET:  /search/polygon/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
geometries:
{
Description: Comma separated list of geometry UUIDs, previously retrieved from an Online Search request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
additionalData:
{
Description: Results array ,
Required: False ,
}
[
{
providerID:
{
Description: ID of the returned entity ,
Required: False ,
}
string ,
error:
{
Description: Reason for the failure to obtain data for this provider. ,
Required: False ,
}
string ,
geometryData:
{
Description: Geometry data in GeoJSON format. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. Present only if "error" is not present. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchFuzzy (removed)
Description :  **Free Form Search** **Applies to**: S0 and S1 pricing tiers. The basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical 'single line search'. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point.

We strongly advise you to use the 'countrySet' parameter to specify only the countries for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.

E.g.: `countrySet`=US,FR

Please see [Search Coverage](https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) for a complete list of all the supported countries.

Most Search queries default to `maxFuzzyLevel`=2 to gain performance and also reduce unusual results. This new default can be overridden as needed per request by passing in the query param `maxFuzzyLevel`=3 or 4.
Reference :  Link ¶

⚼ Request

GET:  /search/fuzzy/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query string (e.g., "seattle", "pizza"). Can _also_ be specified as a comma separated string composed by latitude followed by longitude (e.g., "47.641268, -122.125679"). Must be properly URL encoded. ,
Required: True ,
}
string ,
typeahead:
{
Description: Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode ,
Required: False ,
}
boolean ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
ofs:
{
Description: Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900 ,
Required: False ,
}
integer ,
categorySet:
{
Description: A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: * **categorySet=7315** (Search Points of Interest from category Restaurant) * **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ,
Required: False ,
}
array ,
countrySet:
{
Description: Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries ,
Required: False ,
}
array ,
lat:
{
Description: Latitude where results should be biased. E.g. 37.337 ,
Required: False ,
}
number ,
lon:
{
Description: Longitude where results should be biased. E.g. -121.89 ,
Required: False ,
}
number ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
number ,
topLeft:
{
Description: Top left position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
btmRight:
{
Description: Bottom right position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **Addr** = Address ranges **Geo** = Geographies **PAD** = Point Addresses **POI** = Points of Interest **Str** = Streets **XStr** = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or **None** for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
minFuzzyLevel:
{
Description: Minimum fuzziness level to be used. Default: 1, minimum: 1 and maximum: 4 * Level 1 has no spell checking. * Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant." * Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching. * Level 4 doesn’t add any more spell checking functions. The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel. ,
Required: False ,
}
integer ,
maxFuzzyLevel:
{
Description: Maximum fuzziness level to be used. Default: 2, minimum: 1 and maximum: 4 * Level 1 has no spell checking. * Level 2 uses normal n-gram spell checking. For example, query "restrant" can be matched to "restaurant." * Level 3 uses sound-like spell checking, and shingle spell checking. Sound-like spell checking is for "rstrnt" to "restaurant" matching. Shingle spell checking is for "mountainview" to "mountain view" matching. * Level 4 doesn’t add any more spell checking functions. The search engine will start looking for a match on the level defined by minFuzzyLevel, and will stop searching at the level specified by maxFuzzyLevel. ,
Required: False ,
}
integer ,
idxSet:
{
Description: A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections) ,
Required: False ,
}
array ,
brandSet:
{
Description: A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar ,
Required: False ,
}
array ,
connectorSet:
{
Description: A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are: * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets). * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point. * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard. * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe. Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached ,
Required: False ,
}
array ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
openingHours:
{
Description: Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. Supported value: nextSevenDays ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Fuzzy response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
}
,
results:
{
Description: Results array ,
Required: False ,
}
[
{
type:
{
Description: One of: * POI * Street * Geography * Point Address * Address Range * Cross Street ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
info:
{
Description: Info property ,
Required: False ,
}
string ,
entityType:
{
Description: Geography entity type. Present only when entityType was requested and is available. ,
Enum:
{
Country: Country name ,
CountrySubdivision: State or Province ,
CountrySecondarySubdivision: County ,
CountryTertiarySubdivision: Named Area ,
Municipality: City / Town ,
MunicipalitySubdivision: Sub / Super City ,
Neighbourhood: Neighbourhood ,
PostalCodeArea: Postal Code / Zip Code ,
}
,
Required: False ,
}
enum ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: __[Deprecated]__ Use classifications instead. Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the Request ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
addressRanges:
{
Description: Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included. ,
Required: False ,
}
{
rangeLeft:
{
Required: False ,
}
string ,
rangeRight:
{
Required: False ,
}
string ,
from:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
to:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
dataSources:
{
Description: Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API. ,
Required: False ,
}
{
geometry:
{
Description: Information about the geometric shape of the result. Only present if type == Geography. ,
Required: False ,
}
{
id:
{
Description: Pass this as geometryId to the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API to fetch geometry information for this result. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchPOI (removed)
Description :  **Get POI by Name** **Applies to**: S0 and S1 pricing tiers. Points of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.
Reference :  Link ¶

⚼ Request

GET:  /search/poi/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The POI name to search for (e.g., "statue of liberty", "starbucks"), must be properly URL encoded. ,
Required: True ,
}
string ,
typeahead:
{
Description: Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode ,
Required: False ,
}
boolean ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
ofs:
{
Description: Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900 ,
Required: False ,
}
integer ,
categorySet:
{
Description: A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: * **categorySet=7315** (Search Points of Interest from category Restaurant) * **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ,
Required: False ,
}
array ,
countrySet:
{
Description: Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries ,
Required: False ,
}
array ,
lat:
{
Description: Latitude where results should be biased. E.g. 37.337 ,
Required: False ,
}
number ,
lon:
{
Description: Longitude where results should be biased. E.g. -121.89 ,
Required: False ,
}
number ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
number ,
topLeft:
{
Description: Top left position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
btmRight:
{
Description: Bottom right position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **POI** = Points of Interest Value should be **POI** or **None** to disable extended postal codes. By default extended postal codes are included. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
brandSet:
{
Description: A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar ,
Required: False ,
}
array ,
connectorSet:
{
Description: A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are: * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets). * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point. * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard. * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe. Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached ,
Required: False ,
}
array ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
openingHours:
{
Description: Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. Supported value: nextSevenDays ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search POI response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
geoBias:
{
Description: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
}
,
results:
{
Description: Results array ,
Required: False ,
}
[
{
type:
{
Description: Type property ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
dist:
{
Description: Straight line distance between the result and geobias location in meters. ,
Required: False ,
}
number ,
info:
{
Description: Info property ,
Required: False ,
}
string ,
entityType:
{
Description: Geography entity type. Present only when entityType was requested and is available. ,
Enum:
{
Country: Country name ,
CountrySubdivision: State or Province ,
CountrySecondarySubdivision: County ,
CountryTertiarySubdivision: Named Area ,
Municipality: City / Town ,
MunicipalitySubdivision: Sub / Super City ,
Neighbourhood: Neighbourhood ,
PostalCodeArea: Postal Code / Zip Code ,
}
,
Required: False ,
}
enum ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: __[Deprecated]__ Use classifications instead. Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the Request ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchNearby (removed)
Description :  **Nearby Search** **Applies to**: S0 and S1 pricing tiers. If you have a use case for only retrieving POI results around a specific location, the nearby search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.
Reference :  Link ¶

⚼ Request

GET:  /search/nearby/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
lat:
{
Description: Latitude where results should be biased. E.g. 37.337. ,
Required: True ,
}
number ,
lon:
{
Description: Longitude where results should be biased. E.g. -121.89. ,
Required: True ,
}
number ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
ofs:
{
Description: Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900 ,
Required: False ,
}
integer ,
categorySet:
{
Description: A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: * **categorySet=7315** (Search Points of Interest from category Restaurant) * **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ,
Required: False ,
}
array ,
countrySet:
{
Description: Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries ,
Required: False ,
}
array ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000. ,
Required: False ,
}
number ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **Addr** = Address ranges **Geo** = Geographies **PAD** = Point Addresses **POI** = Points of Interest **Str** = Streets **XStr** = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or **None** for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
brandSet:
{
Description: A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar ,
Required: False ,
}
array ,
connectorSet:
{
Description: A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are: * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets). * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point. * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard. * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe. Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached ,
Required: False ,
}
array ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Nearby response ,
Required: False ,
}
{
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
geoBias:
{
Description: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
}
,
results:
{
Description: Results array ,
Required: False ,
}
[
{
type:
{
Description: Type property ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
dist:
{
Description: Straight line distance between the result and geobias location in meters. ,
Required: False ,
}
number ,
info:
{
Description: Info property ,
Required: False ,
}
string ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: __[Deprecated]__ Use classifications instead. Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the Request ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchPOICategory (removed)
Description :  **Get POI by Category** **Applies to**: S0 and S1 pricing tiers. Points of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.
Reference :  Link ¶

⚼ Request

GET:  /search/poi/category/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The POI category to search for (e.g., "AIRPORT", "RESTAURANT"), must be properly URL encoded. Supported main categories can be requested by calling [Get Search POI Category Tree API](https://aka.ms/AzureMapsPOICategoryTree). List of available categories can also be found [here](https://docs.microsoft.com/azure/azure-maps/supported-search-categories). We recommend to use POI Search Category Tree API to request the supported categories. ,
Required: True ,
}
string ,
typeahead:
{
Description: Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode ,
Required: False ,
}
boolean ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
ofs:
{
Description: Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900 ,
Required: False ,
}
integer ,
categorySet:
{
Description: A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: * **categorySet=7315** (Search Points of Interest from category Restaurant) * **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ,
Required: False ,
}
array ,
countrySet:
{
Description: Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries ,
Required: False ,
}
array ,
lat:
{
Description: Latitude where results should be biased. E.g. 37.337 ,
Required: False ,
}
number ,
lon:
{
Description: Longitude where results should be biased. E.g. -121.89 ,
Required: False ,
}
number ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
number ,
topLeft:
{
Description: Top left position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
btmRight:
{
Description: Bottom right position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **Addr** = Address ranges **Geo** = Geographies **PAD** = Point Addresses **POI** = Points of Interest **Str** = Streets **XStr** = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or **None** for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
brandSet:
{
Description: A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar ,
Required: False ,
}
array ,
connectorSet:
{
Description: A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are: * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets). * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point. * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard. * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe. Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached ,
Required: False ,
}
array ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
openingHours:
{
Description: Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. Supported value: nextSevenDays ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search POI Category response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
geoBias:
{
Description: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
}
,
results:
{
Description: Results array ,
Required: False ,
}
[
{
type:
{
Description: Type property ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
dist:
{
Description: Straight line distance between the result and geobias location in meters. ,
Required: False ,
}
number ,
info:
{
Description: Info property ,
Required: False ,
}
string ,
entityType:
{
Description: Geography entity type. Present only when entityType was requested and is available. ,
Enum:
{
Country: Country name ,
CountrySubdivision: State or Province ,
CountrySecondarySubdivision: County ,
CountryTertiarySubdivision: Named Area ,
Municipality: City / Town ,
MunicipalitySubdivision: Sub / Super City ,
Neighbourhood: Neighbourhood ,
PostalCodeArea: Postal Code / Zip Code ,
}
,
Required: False ,
}
enum ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: __[Deprecated]__ Use classifications instead. Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the Request ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchPOICategoryTreePreview (removed)
Description :  **Get POI Category Tree** **Applies to**: S0 and S1 pricing tiers. POI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi).
Reference :  Link ¶

⚼ Request

GET:  /search/poi/category/tree/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English). Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
poiCategories:
{
Description: Categories array ,
Required: False ,
}
[
{
id:
{
Description: Unique ID for the category. ID can be used to restrict search results to specific categories through other Search Service APIs, like [Get Search POI](https://docs.microsoft.com/rest/api/maps/search/getsearchpoi). ,
Required: False ,
}
integer ,
name:
{
Description: Name of the category ,
Required: False ,
}
string ,
childCategoryIds:
{
Description: Array of child category ids ,
Required: False ,
}
[
integer ,
]
,
synonyms:
{
Description: Array of alternative names of the category ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchAddress (removed)
Description :  **Address Geocoding** **Applies to**: S0 and S1 pricing tiers. In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocode endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.
Reference :  Link ¶

⚼ Request

GET:  /search/address/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The address to search for (e.g., "1 Microsoft way, Redmond, WA"), must be properly URL encoded. ,
Required: True ,
}
string ,
typeahead:
{
Description: Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode ,
Required: False ,
}
boolean ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
ofs:
{
Description: Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900 ,
Required: False ,
}
integer ,
countrySet:
{
Description: Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries ,
Required: False ,
}
array ,
lat:
{
Description: Latitude where results should be biased. E.g. 37.337 ,
Required: False ,
}
number ,
lon:
{
Description: Longitude where results should be biased. E.g. -121.89 ,
Required: False ,
}
number ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
number ,
topLeft:
{
Description: Top left position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
btmRight:
{
Description: Bottom right position of the bounding box. E.g. 37.553,-122.453 ,
Required: False ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **Addr** = Address ranges **Geo** = Geographies **PAD** = Point Addresses **POI** = Points of Interest **Str** = Streets **XStr** = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or **None** for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Address response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
}
,
results:
{
Description: Results array ,
Required: False ,
}
[
{
type:
{
Description: One of: * POI * Street * Geography * Point Address * Address Range * Cross Street ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
dataSources:
{
Description: Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API. ,
Required: False ,
}
{
geometry:
{
Description: Information about the geometric shape of the result. Only present if type == Geography. ,
Required: False ,
}
{
id:
{
Description: Pass this as geometryId to the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API to fetch geometry information for this result. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchAddressReverse (removed)
Description :  **Reverse Geocode to an Address** **Applies to**: S0 and S1 pricing tiers. There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.
Reference :  Link ¶

⚼ Request

GET:  /search/address/reverse/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
returnSpeedLimit:
{
Description: Boolean. To enable return of the posted speed limit ,
Required: False ,
}
boolean ,
heading:
{
Description: The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place ,
Required: False ,
}
number ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
number ,
number:
{
Description: If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number ,
Required: False ,
}
string ,
returnRoadUse:
{
Description: Boolean. To enable return of the road use array for reverse geocodes at street level ,
Required: False ,
}
boolean ,
roadUse:
{
Description: To restrict reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet ,
Required: False ,
}
string ,
allowFreeformNewline:
{
Description: Format of newlines in the formatted address. If true, the address will contain newlines. If false, newlines will be converted to commas. ,
Required: False ,
}
boolean ,
returnMatchType:
{
Description: Include information on the type of match the geocoder achieved in the response. ,
Required: False ,
}
boolean ,
entityType:
{
Description: Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API. The following parameters are ignored when entityType is set: * heading * number * returnRoadUse * returnSpeedLimit * roadUse * returnMatchType ,
Required: False ,
}
string ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Address Reverse response ,
Required: False ,
}
{
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
}
,
addresses:
{
Description: Addresses array ,
Required: False ,
}
[
{
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: Position property in the form of "{latitude},{longitude}" ,
Required: False ,
}
string ,
matchType:
{
Description: Information on the type of match. One of: * AddressPoint * HouseNumberRange * Street ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchAddressReverseCrossStreet (removed)
Description :  **Reverse Geocode to a Cross Street** **Applies to**: S0 and S1 pricing tiers. There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return cross street information for a given coordinate.
Reference :  Link ¶

⚼ Request

GET:  /search/address/reverse/crossStreet/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
query:
{
Description: The applicable query specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
heading:
{
Description: The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include upto one decimal place ,
Required: False ,
}
number ,
radius:
{
Description: The radius in meters to for the results to be constrained to the defined area ,
Required: False ,
}
number ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Address Reverse Cross Street response ,
Required: False ,
}
{
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
}
,
addresses:
{
Description: Addresses array ,
Required: False ,
}
[
{
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: Position property in the form of "{latitude},{longitude}" ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_GetSearchAddressStructured (removed)
Description :  **Structured Address Geocoding** **Applies to**: S0 and S1 pricing tiers. Azure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.
Reference :  Link ¶

⚼ Request

GET:  /search/address/structured/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
countryCode:
{
Description: The 2 or 3 letter [ISO3166-1](https://www.iso.org/iso-3166-country-codes.html) country code portion of an address. E.g. US. ,
Required: True ,
}
string ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
ofs:
{
Description: Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900 ,
Required: False ,
}
integer ,
streetNumber:
{
Description: The street number portion of an address ,
Required: False ,
}
string ,
streetName:
{
Description: The street name portion of an address ,
Required: False ,
}
string ,
crossStreet:
{
Description: The cross street name for the structured address ,
Required: False ,
}
string ,
municipality:
{
Description: The municipality portion of an address ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: The municipality subdivision (sub/super city) for the structured address ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: The named area for the structured address ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: The county for the structured address ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: The country subdivision portion of an address ,
Required: False ,
}
string ,
postalCode:
{
Description: The postal code portion of an address ,
Required: False ,
}
string ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **Addr** = Address ranges **Geo** = Geographies **PAD** = Point Addresses **POI** = Points of Interest **Str** = Streets **XStr** = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or **None** for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Address Structured response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
limit:
{
Description: Maximum number of responses that will be returned ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
geoBias:
{
Description: Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
}
,
results:
{
Description: Results array ,
Required: False ,
}
[
{
type:
{
Description: Type property ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
dist:
{
Description: Straight line distance between the result and geobias location in meters. ,
Required: False ,
}
number ,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
addressRanges:
{
Description: Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included. ,
Required: False ,
}
{
rangeLeft:
{
Required: False ,
}
string ,
rangeRight:
{
Required: False ,
}
string ,
from:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
to:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_PostSearchInsideGeometry (removed)
Description :  **Applies to**: S0 and S1 pricing tiers. The Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.

To send the geometry you will use a `POST` request where the request body will contain the `geometry` object represented as a `GeoJSON` type and the `Content-Type` header will be set to `application/json`. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following `GeoJSON` types:
  • **GeoJSON FeatureCollection**
    The `geometry` can be represented as a `GeoJSON FeatureCollection` object. This is the recommended option if the geometry contains both Polygons and Circles. The `FeatureCollection` can contain a max of 50 `GeoJSON Feature` objects. Each `Feature` object should represent either a Polygon or a Circle with the following conditions:
    • A `Feature` object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.
    • A `Feature` object for the Circle geometry is composed of a _center_ represented using a `GeoJSON Point` type and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.

    Please see the Examples section below for a sample `FeatureCollection` representation.

  • **GeoJSON GeometryCollection**
    The `geometry` can be represented as a `GeoJSON GeometryCollection` object. This is the recommended option if the geometry contains a list of Polygons only. The `GeometryCollection` can contain a max of 50 `GeoJSON Polygon` objects. Each `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `GeometryCollection` representation.

  • **GeoJSON Polygon**
    The `geometry` can be represented as a `GeoJSON Polygon` object. This is the recommended option if the geometry contains a single Polygon. The `Polygon` object can have a max of 50 coordinates. Please see the Examples section below for a sample `Polygon` representation.

.
Reference :  Link ¶

⚼ Request

POST:  /search/geometry/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
query:
{
Description: The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza"). Must be properly URL encoded. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
limit:
{
Description: Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100 ,
Required: False ,
}
integer ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
categorySet:
{
Description: A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: * **categorySet=7315** (Search Points of Interest from category Restaurant) * **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ,
Required: False ,
}
array ,
extendedPostalCodesFor:
{
Description: Indexes for which extended postal codes should be included in the results. Available indexes are: **Addr** = Address ranges **Geo** = Geographies **PAD** = Point Addresses **POI** = Points of Interest **Str** = Streets **XStr** = Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or **None** for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed. Usage examples: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Extended postal code is returned as an **extendedPostalCode** property of an address. Availability is region-dependent. ,
Required: False ,
}
string ,
idxSet:
{
Description: A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections) ,
Required: False ,
}
array ,
searchInsideGeometryRequestBody:
{
Description: This represents the geometry for one or more geographical features (parks, state boundary etc.) to search in and should be a GeoJSON compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. ,
Required: True ,
}
{
geometry:
{
Description: This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a `GeoJSON` compliant type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946) for details. ,
Required: False ,
}
object ,
}
,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
openingHours:
{
Description: Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. Supported value: nextSevenDays ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Geometry response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
}
,
results:
{
Description: A list of Search Inside Geometry results. ,
Required: False ,
}
[
{
type:
{
Description: Type property ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
info:
{
Description: Info property ,
Required: False ,
}
string ,
entityType:
{
Description: Geography entity type. Present only when entityType was requested and is available. ,
Enum:
{
Country: Country name ,
CountrySubdivision: State or Province ,
CountrySecondarySubdivision: County ,
CountryTertiarySubdivision: Named Area ,
Municipality: City / Town ,
MunicipalitySubdivision: Sub / Super City ,
Neighbourhood: Neighbourhood ,
PostalCodeArea: Postal Code / Zip Code ,
}
,
Required: False ,
}
enum ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: __[Deprecated]__ Use classifications instead. Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the Request ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_PostSearchAlongRoute (removed)
Description :  **Applies to**: S0 and S1 pricing tiers. The Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the `maxDetourTime` limiting measure.

To send the route-points you will use a `POST` request where the request body will contain the `route` object represented as a `GeoJSON LineString` type and the `Content-Type` header will be set to `application/json`. Each route-point in `route` is represented as a `GeoJSON Position` type i.e. an array where the _longitude_ value is followed by the _latitude_ value and the _altitude_ value is ignored. The `route` should contain at least 2 route-points.

It is possible that original route will be altered, some of it's points may be skipped. If the route that passes through the found point is faster than the original one, the `detourTime` value in the response is negative.
Reference :  Link ¶

⚼ Request

POST:  /search/alongRoute/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
categorySet:
{
Description: A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  [POI Categories API](https://aka.ms/AzureMapsPOICategoryTree). Usage examples: * **categorySet=7315** (Search Points of Interest from category Restaurant) * **categorySet=7315025,7315017** (Search Points of Interest of category either Italian or French Restaurant) ,
Required: False ,
}
array ,
query:
{
Description: The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza"). Must be properly URL encoded. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Value can be either _json_ or _xml_. ,
Required: True ,
}
string ,
maxDetourTime:
{
Description: Maximum detour time of the point of interest in seconds. Max value is 3600 seconds ,
Required: True ,
}
integer ,
limit:
{
Description: Maximum number of responses that will be returned. Default value is 10. Max value is 20 ,
Required: False ,
}
integer ,
brandSet:
{
Description: A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes. Usage examples: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar ,
Required: False ,
}
array ,
connectorSet:
{
Description: A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Available connector types are: * `StandardHouseholdCountrySpecific` - These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: [Plug & socket types - World Standards](https://www.worldstandards.eu/electricity/plugs-and-sockets). * `IEC62196Type1` - Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. * `IEC62196Type1CCS` - Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type2CableAttached` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point. * `IEC62196Type2Outlet` - Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. * `IEC62196Type2CCS` - Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. * `IEC62196Type3` - Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. * `Chademo` - CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. * `IEC60309AC1PhaseBlue` - Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. * `IEC60309DCWhite` - Industrial White connector is a DC connector defined in the IEC 60309 standard. * `Tesla` - The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe. Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached ,
Required: False ,
}
array ,
view:
{
Description: The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
openingHours:
{
Description: Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. Supported value: nextSevenDays ,
Required: False ,
}
string ,
searchAlongRouteRequestBody:
{
Description: This represents the route to search along and should be a valid `GeoJSON LineString` type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details. ,
Required: True ,
}
{
route:
{
Description: A valid `GeoJSON LineString` geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.1.4) for details. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary object for a Search Along Route response ,
Required: False ,
}
{
query:
{
Description: Query property ,
Required: False ,
}
string ,
queryType:
{
Description: QueryType property ,
Required: False ,
}
string ,
queryTime:
{
Description: QueryTime property ,
Required: False ,
}
integer ,
numResults:
{
Description: NumResults property ,
Required: False ,
}
integer ,
offset:
{
Description: Offset property ,
Required: False ,
}
integer ,
totalResults:
{
Description: TotalResults property ,
Required: False ,
}
integer ,
fuzzyLevel:
{
Description: FuzzyLevel property ,
Required: False ,
}
integer ,
}
,
results:
{
Description: A list of Search Along Route results. ,
Required: False ,
}
[
{
type:
{
Description: Type property ,
Required: False ,
}
string ,
id:
{
Description: Id property ,
Required: False ,
}
string ,
score:
{
Description: The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. ,
Required: False ,
}
number ,
info:
{
Description: Info property ,
Required: False ,
}
string ,
entityType:
{
Description: Geography entity type. Present only when entityType was requested and is available. ,
Enum:
{
Country: Country name ,
CountrySubdivision: State or Province ,
CountrySecondarySubdivision: County ,
CountryTertiarySubdivision: Named Area ,
Municipality: City / Town ,
MunicipalitySubdivision: Sub / Super City ,
Neighbourhood: Neighbourhood ,
PostalCodeArea: Postal Code / Zip Code ,
}
,
Required: False ,
}
enum ,
poi:
{
Description: Details of the returned POI including information such as the name, phone, url address, and classifications. ,
Required: False ,
}
{
name:
{
Description: Name of the POI property ,
Required: False ,
}
string ,
phone:
{
Description: Telephone number property ,
Required: False ,
}
string ,
url:
{
Description: Website URL property ,
Required: False ,
}
string ,
categorySet:
{
Description: The list of the most specific POI categories ,
Required: False ,
}
[
{
id:
{
Description: Category ID ,
Required: False ,
}
integer ,
}
,
]
,
categories:
{
Description: __[Deprecated]__ Use classifications instead. Categories array ,
Required: False ,
}
[
string ,
]
,
classifications:
{
Description: Classification array ,
Required: False ,
}
[
{
code:
{
Description: Code property ,
Required: False ,
}
string ,
names:
{
Description: Names array ,
Required: False ,
}
[
{
nameLocale:
{
Description: Name Locale property ,
Required: False ,
}
string ,
name:
{
Description: Name property ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
brands:
{
Description: Brands array. The name of the brand for the POI being returned. ,
Required: False ,
}
[
{
name:
{
Description: Name of the brand ,
Required: False ,
}
string ,
}
,
]
,
openingHours:
{
Description: Opening hours for a POI (Points of Interest). ,
Required: False ,
}
{
mode:
{
Description: Value used in the Request ,
Required: False ,
}
string ,
timeRanges:
{
Description: List of time ranges for the next 7 days ,
Required: False ,
}
[
{
startTime:
{
Description: The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
endTime:
{
Description: The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range. ,
Required: False ,
}
{
date:
{
Description: Represents current day in calendar year in POI time zone. ,
Required: False ,
}
string ,
hour:
{
Description: Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. ,
Required: False ,
}
integer ,
minute:
{
Description: Minutes are in the local time of a POI; possible values are 0 - 59. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
}
,
address:
{
Description: The address of the result ,
Required: False ,
}
{
buildingNumber:
{
Description: Building Number property ,
Required: False ,
}
string ,
street:
{
Description: Street property ,
Required: False ,
}
string ,
crossStreet:
{
Description: Cross Street property ,
Required: False ,
}
string ,
streetNumber:
{
Description: Street Number property ,
Required: False ,
}
string ,
routeNumbers:
{
Description: number of routes ,
Required: False ,
}
[
integer ,
]
,
streetName:
{
Description: Street Name property ,
Required: False ,
}
string ,
streetNameAndNumber:
{
Description: Street Name and Number property ,
Required: False ,
}
string ,
municipality:
{
Description: Municipality property ,
Required: False ,
}
string ,
municipalitySubdivision:
{
Description: Municipality Subdivision property ,
Required: False ,
}
string ,
countryTertiarySubdivision:
{
Description: Country Tertiary Subdivision property ,
Required: False ,
}
string ,
countrySecondarySubdivision:
{
Description: Country Secondary Subdivision property ,
Required: False ,
}
string ,
countrySubdivision:
{
Description: Country Subdivision property ,
Required: False ,
}
string ,
postalCode:
{
Description: Postal Code property ,
Required: False ,
}
string ,
extendedPostalCode:
{
Description: Extended Postal Code property ,
Required: False ,
}
string ,
countryCode:
{
Description: Country Code property ,
Required: False ,
}
string ,
country:
{
Description: Country property ,
Required: False ,
}
string ,
countryCodeISO3:
{
Description: Country Code ISO3 property ,
Required: False ,
}
string ,
freeformAddress:
{
Description: Free form Address property ,
Required: False ,
}
string ,
countrySubdivisionName:
{
Description: Country Subdivision Name property ,
Required: False ,
}
string ,
localName:
{
Description: An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. ,
Required: False ,
}
string ,
}
,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
viewport:
{
Description: The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. ,
Required: False ,
}
{
topLeftPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
btmRightPoint:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
entryPoints:
{
Description: Entry Points array ,
Required: False ,
}
[
{
type:
{
Description: The type of entry point. Value can be either _main_ or _minor_. ,
Enum:
{
main: No description available. ,
minor: No description available. ,
}
,
Required: False ,
}
enum ,
position:
{
Description: A location represented as a latitude and longitude. ,
Required: False ,
}
{
lat:
{
Description: Latitude property ,
Format: double ,
Required: False ,
}
number ,
lon:
{
Description: Longitude property ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
dist:
{
Description: Straight line distance between the result and geobias location in meters. ,
Required: False ,
}
number ,
detourTime:
{
Description: Detour time in seconds ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_PostSearchFuzzyBatch (removed)
Description :  **Search Fuzzy Batch API** **Applies to**: S1 pricing tier. The Search Address Batch API sends batches of queries to [Search Fuzzy API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy) using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key} ``` ### Submit Asynchronous Batch Request The Asynchronous API is appropriate for processing big volumes of relatively complex search requests - It allows the retrieval of results in a separate call (multiple downloads are possible). - The asynchronous API is optimized for reliability and is not expected to run into a timeout. - The number of batch items is limited to **10,000** for this API. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: 1. Client sends a Search Address Batch `POST` request to Azure Maps 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request has been accepted. > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code. 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request. This status URI looks like following: ``` GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results. ### POST Body for Batch Request To send the _search fuzzy_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search fuzzy_ queries: ```json { "batchItems": [ {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"}, {"query": "?query=Statue Of Liberty&limit=2"}, {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"}, {"query": "?query=Space Needle"}, {"query": "?query=pizza&limit=10"} ] } ``` A _search fuzzy_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search fuzzy_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#uri-parameters). The string values in the _search fuzzy_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded. The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query. ### Download Asynchronous Batch Results To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: ``` https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` Here's the typical sequence of operations for downloading the batch results: 1. Client sends a `GET` request using the _download URL_. 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time. > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results. ### Batch Response Model The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types: - [`SearchFuzzyResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchfuzzy#searchfuzzyresponse) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case. Here's a sample Batch Response with 2 _successful_ and 1 _failed_ result: ```json { "summary": { "successfulRequests": 2, "totalRequests": 3 }, "batchItems": [ { "statusCode": 200, "response": { "summary": { "query": "atm" }, "results": [ { "type": "POI", "poi": { "name": "ATM at Wells Fargo" }, "address": { "country": "United States Of America", "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052" } } ] } }, { "statusCode": 200, "response": { "summary": { "query": "statue of liberty" }, "results": [ { "type": "POI", "poi": { "name": "Statue of Liberty" }, "address": { "country": "United States Of America", "freeformAddress": "New York, NY 10004" } } ] } }, { "statusCode": 400, "response": { "error": { "code": "400 BadRequest", "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." } } } ] } ```
Reference :  Link ¶

⚼ Request

POST:  /search/fuzzy/batch/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
searchFuzzyBatchRequestBody:
{
Description: The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries/requests to process ,
Required: False ,
}
[
{
query:
{
Description: Partial query string ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (202)

{
location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_PostSearchAddressBatch (removed)
Description :  **Search Address Batch API** **Applies to**: S1 pricing tier. The Search Address Batch API sends batches of queries to [Search Address API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress) using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key} ``` ### Submit Asynchronous Batch Request The Asynchronous API is appropriate for processing big volumes of relatively complex search requests - It allows the retrieval of results in a separate call (multiple downloads are possible). - The asynchronous API is optimized for reliability and is not expected to run into a timeout. - The number of batch items is limited to **10,000** for this API. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: 1. Client sends a Search Address Batch `POST` request to Azure Maps 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request has been accepted. > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code. 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request. This status URI looks like following: ``` GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results. ### POST Body for Batch Request To send the _search address_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address_ queries: ```json { "batchItems": [ {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"}, {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"}, {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"}, {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"}, {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"} ] } ``` A _search address_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#uri-parameters). The string values in the _search address_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded. The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query. ### Download Asynchronous Batch Results To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: ``` https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` Here's the typical sequence of operations for downloading the batch results: 1. Client sends a `GET` request using the _download URL_. 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time. > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results. ### Batch Response Model The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types: - [`SearchAddressResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress#searchaddressresponse) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case. Here's a sample Batch Response with 2 _successful_ and 1 _failed_ result: ```json { "summary": { "successfulRequests": 2, "totalRequests": 3 }, "batchItems": [ { "statusCode": 200, "response": { "summary": { "query": "one microsoft way redmond wa 98052" }, "results": [ { "position": { "lat": 47.63989, "lon": -122.12509 } } ] } }, { "statusCode": 200, "response": { "summary": { "query": "pike pl seattle wa 98101" }, "results": [ { "position": { "lat": 47.60963, "lon": -122.34215 } } ] } }, { "statusCode": 400, "response": { "error": { "code": "400 BadRequest", "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." } } } ] } ```
Reference :  Link ¶

⚼ Request

POST:  /search/address/batch/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
searchAddressBatchRequestBody:
{
Description: The list of address geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries/requests to process ,
Required: False ,
}
[
{
query:
{
Description: Partial query string ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (202)

{
location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Search_PostSearchAddressReverseBatch (removed)
Description :  **Search Address Reverse Batch API** **Applies to**: S1 pricing tier. The Search Address Batch API sends batches of queries to [Search Address Reverse API](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse) using just a single API call. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries. ### Submit Synchronous Batch Request The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to **100** for this API. ``` POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key} ``` ### Submit Asynchronous Batch Request The Asynchronous API is appropriate for processing big volumes of relatively complex search requests - It allows the retrieval of results in a separate call (multiple downloads are possible). - The asynchronous API is optimized for reliability and is not expected to run into a timeout. - The number of batch items is limited to **10,000** for this API. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period. Please note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations: 1. Client sends a Search Address Batch `POST` request to Azure Maps 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request has been accepted. > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code. 3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request. This status URI looks like following: ``` GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` 4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results. ### POST Body for Batch Request To send the _search address reverse_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 5 _search address reverse_ queries: ```json { "batchItems": [ {"query": "?query=48.858561,2.294911"}, {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"}, {"query": "?query=47.621028,-122.348170"}, {"query": "?query=43.722990,10.396695"}, {"query": "?query=40.750958,-73.982336"} ] } ``` A _search address reverse_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _search address reverse_ [URI parameters](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#uri-parameters). The string values in the _search address reverse_ query must be properly escaped (e.g. " character should be escaped with \\ ) and it should also be properly URL-encoded. The async API allows caller to batch up to **10,000** queries and sync API up to **100** queries, and the batch should contain at least **1** query. ### Download Asynchronous Batch Results To download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following: ``` https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} ``` Here's the typical sequence of operations for downloading the batch results: 1. Client sends a `GET` request using the _download URL_. 2. The server will respond with one of the following: > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time. > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results. ### Batch Response Model The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types: - [`SearchAddressReverseResponse`](https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddressreverse#searchaddressreverseresponse) - If the query completed successfully. - `Error` - If the query failed. The response will contain a `code` and a `message` in this case. Here's a sample Batch Response with 2 _successful_ and 1 _failed_ result: ```json { "summary": { "successfulRequests": 2, "totalRequests": 3 }, "batchItems": [ { "statusCode": 200, "response": { "summary": { "queryTime": 11 }, "addresses": [ { "address": { "country": "France", "freeformAddress": "Avenue Anatole France, 75007 Paris" }, "position": "48.858490,2.294820" } ] } }, { "statusCode": 200, "response": { "summary": { "queryTime": 1 }, "addresses": [ { "address": { "country": "United States of America", "freeformAddress": "157th Pl NE, Redmond WA 98052" }, "position": "47.640470,-122.129430" } ] } }, { "statusCode": 400, "response": { "error": { "code": "400 BadRequest", "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive." } } } ] } ```
Reference :  Link ¶

⚼ Request

POST:  /search/address/reverse/batch/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
searchAddressReverseBatchRequestBody:
{
Description: The list of reverse geocoding queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query. ,
Required: True ,
}
{
batchItems:
{
Description: The list of queries/requests to process ,
Required: False ,
}
[
{
query:
{
Description: Partial query string ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
summary:
{
Description: Summary for the batch request ,
Required: False ,
}
{
successfulRequests:
{
Description: Number of successful requests in the batch ,
Required: False ,
}
integer ,
totalRequests:
{
Description: Total number of requests in the batch ,
Required: False ,
}
integer ,
}
,
batchItems:
{
Description: Array containing the batch results ,
Required: False ,
}
[
object ,
]
,
}

⚐ Response (202)

{
location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}